Add warning for header_register_callback usage - #5760
Merged
Conversation
Added a warning about callback de-registration in header_register_callback.
jordikroon
requested changes
Aug 13, 2026
| <para> | ||
| Callbacks are not stacked. Subsequent calls to <function>header_register_callback</function> | ||
| will silently de-register any existing <parameter>callback</parameter>, regardless of where | ||
| it was set. Be aware that dependencies could overwrite your callback. |
Member
There was a problem hiding this comment.
“your callback” should simply become “the callback” as we don’t allow personalization according to the style guidelines. I am also thinking whether could is the correct choice. Shouldn’t we should may instead as it’s conditionally.
And by docbook CS, the outer should become simpara.
Contributor
Author
There was a problem hiding this comment.
I've applied these suggestions. Thanks!
jordikroon
approved these changes
Aug 14, 2026
Member
|
Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a warning about callback de-registration in header_register_callback.